Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Microsoft.Extensions.Options.OptionsBuilder<TOptions>
Assembly: Microsoft.Extensions.Options
Inheritance: object → OptionsBuilder
Configures <typeparamref name="TOptions" /> instances.
Properties
public
string
Name
Gets the default name of the <typeparamref name="TOptions" /> instance.
Services
Gets the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> for the options being configured.
Methods
public
OptionsBuilder<TOptions>
Configure(System.Action<TOptions> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
Configure(System.Action<TOptions, TDep> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
Configure(System.Action<TOptions, TDep1, TDep2> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
Configure(System.Action<TOptions, TDep1, TDep2, TDep3> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
Configure(System.Action<TOptions, TDep1, TDep2, TDep3, TDep4> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
Configure(System.Action<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run before all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.PostConfigure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
PostConfigure(System.Action<TOptions> configureOptions)
Registers an action used to configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
PostConfigure(System.Action<TOptions, TDep> configureOptions)
Registers an action used to post configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
PostConfigure(System.Action<TOptions, TDep1, TDep2> configureOptions)
Registers an action used to post configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
PostConfigure(System.Action<TOptions, TDep1, TDep2, TDep3> configureOptions)
Registers an action used to post configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
PostConfigure(System.Action<TOptions, TDep1, TDep2, TDep3, TDep4> configureOptions)
Registers an action used to post configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
PostConfigure(System.Action<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5> configureOptions)
Registers an action used to post configure a particular type of options.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
configureOptions
The action used to configure the options.
Remarks
These are run after all <see cref="M:Microsoft.Extensions.Options.OptionsBuilder`1.Configure(System.Action{`0})" /> .
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, bool> validation)
Registers a validation action for an options type using a default failure message.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, bool> validation,
string failureMessage)
Registers a validation action for an options type.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
failureMessage
The failure message to use when validation fails.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep, bool> validation)
Registers a validation action for an options type using a default failure message.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep, bool> validation,
string failureMessage)
Registers a validation action for an options type.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
failureMessage
The failure message to use when validation fails.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, bool> validation)
Registers a validation action for an options type using a default failure message.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, bool> validation,
string failureMessage)
Registers a validation action for an options type.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
failureMessage
The failure message to use when validation fails.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, TDep3, bool> validation)
Registers a validation action for an options type using a default failure message.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, TDep3, bool> validation,
string failureMessage)
Registers a validation action for an options type.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
failureMessage
The failure message to use when validation fails.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, TDep3, TDep4, bool> validation)
Registers a validation action for an options type using a default failure message.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, TDep3, TDep4, bool> validation,
string failureMessage)
Registers a validation action for an options type.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
failureMessage
The failure message to use when validation fails.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5, bool> validation)
Registers a validation action for an options type using a default failure message.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
public
OptionsBuilder<TOptions>
Validate(System.Func<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5, bool> validation,
string failureMessage)
Registers a validation action for an options type.
Returns The current <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
validation
The validation function.
failureMessage
The failure message to use when validation fails.
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object